home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / LANG / BASIC / LIB / EVENTSHELL / DOCS / Memory < prev    next >
Text File  |  1996-05-18  |  4KB  |  152 lines
  1.  
  2. PROCshell_HeapBlockReturn()
  3. =>    int    address of heap block
  4.  
  5. Releases the given heap block, returning memory to
  6. the free pool.
  7.  
  8. --------------------------------------------------------
  9.  
  10. PROCshell_HeapBlockInit()
  11. =>    None
  12.  
  13. --------------------------------------------------------
  14.  
  15. FNshell_HeapBlockExtend()
  16. =>    int    address of heap block
  17.     int    amount to increase or decrease block size by
  18.          (-ve to decrease)
  19.  
  20. <=    int    address of heap block
  21.  
  22. Increases or decreases the size of the given heap block
  23. which must have been allocated with FNshell_HeapBlockFetch.
  24. Note that the heap block may be moved to make it fit so you
  25. should always use the returned value for the heap block
  26. address after this call.
  27.  
  28. --------------------------------------------------------
  29.  
  30. FNshell_HeapBlockFetch()
  31. =>    int    size of block to fetch from heap
  32.  
  33. <=    int    address of heapblock allocated
  34.  
  35. Returns address of heapblock or causes an "Out
  36. of memory" error if the block cannot be
  37. allocated.
  38.  
  39. --------------------------------------------------------
  40.  
  41. FNshell_HeapBlockInfo()
  42. =>    int    address of heap block
  43.  
  44. <=    int    size of heap block (Note that this
  45.          is larger than the size requested
  46.          with FNshell_HeapBlockFetch)
  47.  
  48. --------------------------------------------------------
  49.  
  50. PROCshell_HeapManagerInit
  51. =>    str    path to directory containing the
  52.          'heapcode' file
  53.     int    address of heap manager workspace
  54.  
  55. This routine must be called before PROCshell_Init.
  56.  
  57. --------------------------------------------------------
  58.  
  59. FNshell_HeapBlockExists()
  60. =>    int    address to check
  61.  
  62. <=    bool    TRUE or FALSE
  63.  
  64. This routine returns TRUE if a heapblock is present
  65. at the specified address, FALSE otherwise.
  66.  
  67. --------------------------------------------------------
  68.  
  69. PROCshell_MemFill()
  70. =>    int    start address
  71.     int    number of bytes
  72.     int    byte value to fill with
  73.  
  74. --------------------------------------------------------
  75.  
  76. FNshell_HeapBlockExtendMid()
  77. =>    int    address of heap block
  78.     int    amount to increase or decrease block size by
  79.          (-ve to decrease)
  80.     int    offset at which to extend block
  81.  
  82. <=    int    address of heap block
  83.  
  84. Increases or decreases the size of the given heap block
  85. which must have been allocated with <FNshell_HeapBlockFetch>.
  86. Note that the heap block may be moved to make it fit so you
  87. should always use the returned value for the heap block
  88. address after this call.
  89.  
  90. --------------------------------------------------------
  91.  
  92. FNshell_MemLib_GetPageSize
  93. =>    None
  94.  
  95. <=    int    current memory page size
  96.  
  97. Memory is claimed from RiscOS in page sized chunks when all
  98. the free space has been used. Different computers with
  99. different amounts of RAM have different page sizes.
  100.  
  101. --------------------------------------------------------
  102.  
  103. FNshell_MemLib_GetShellDynamicAreaNr
  104. =>    None
  105.  
  106. <=    int    number of dynamic area (-1 if no dynamic
  107.          area has been defined)
  108.  
  109. This dynamic area is created by EvntShell when your
  110. application starts up, providing the application is
  111. running on a Risc PC or better. It will be used by the
  112. new memory claiming routines when I've written them.
  113.  
  114. --------------------------------------------------------
  115.  
  116. FNshell_MemLib_GetShellDynamicAreaSize
  117. =>    None
  118.  
  119. <=    int    size of EvntShell's dynamic workspace
  120.          area (-1 if no area defined)
  121.  
  122. This area will be used by the new memory claiming routines
  123. when I've written them.
  124.  
  125. --------------------------------------------------------
  126.  
  127. FNshell_MemLib_DynamicAreaAvailable
  128. =>    None
  129.  
  130. <=    bool    TRUE if dynamic memory areas are
  131.          available, FALSE otherwise
  132.  
  133. --------------------------------------------------------
  134.  
  135. FNshell_MemLib_GetShellDynamicTotalFree
  136. =>    None
  137.  
  138. <=    int    the total amount of ram currently
  139.          available in EvntShell's dynamic
  140.          memory workspace
  141.  
  142. --------------------------------------------------------
  143.  
  144. FNshell_MemLib_GetShellDynamicNrBlocks
  145. =>    None
  146.  
  147. <=    int    number of heapblocks claimed in
  148.          in EvntShell's dynamic memory
  149.          workspace
  150.  
  151. --------------------------------------------------------
  152.